refactor(core): expose core.locale as LocaleProxy#3820
Merged
Conversation
ST-DDT
added
p: 2-high
✅ Deploy Preview for fakerjs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Member
Author
|
I marked this as P2, because it needs to be decided on prior to the next release. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## next #3820 +/- ##
==========================================
- Coverage 98.90% 98.84% -0.07%
==========================================
Files 897 898 +1
Lines 3103 3113 +10
Branches 556 559 +3
==========================================
+ Hits 3069 3077 +8
- Misses 30 32 +2
Partials 4 4
🚀 New features to boost your workflow:
|
Member
Author
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors locale handling so FakerCore exposes locale data as a LocaleProxy, and adds a raw escape hatch to access underlying LocaleDefinition data without proxy behavior.
Changes:
- Change
FakerCore.localeto be aLocaleProxyand wrap locales viacreateLocaleProxy()increateFakerCore(). - Add
raw(and an internal tag) toLocaleProxy, and allowcreateLocaleProxy()to accept an existingLocaleProxy. - Update modules/tests to use
definitions.rawwhere non-throwing access to locale definitions is needed.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| test/internal/locale-proxy.spec.ts | Adds a test for passing a LocaleProxy into createLocaleProxy(). |
| src/modules/person/index.ts | Switches last-name pattern lookup to use raw definitions. |
| src/modules/helpers/eval.ts | Updates fakeEval default entrypoints to use raw definitions. |
| src/internal/locale-proxy.ts | Extends LocaleProxy with raw + tag and updates proxy creation logic. |
| src/faker.ts | Removes stored definitions field; exposes definitions/rawDefinitions via getters. |
| src/core.ts | Makes FakerCore.locale a LocaleProxy and ensures core construction proxies locales. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Shinigami92
previously approved these changes
Apr 20, 2026
ST-DDT
changed the title
Shinigami92
approved these changes
Apr 21, 2026
xDivisionByZerox
approved these changes
Apr 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Alternative to #3189 and #3819feat: de-proxy locale access #3189feat: introduce resolveLocaleData utility function #3819LocaleProxyinFakerCore.rawattribute to get access to the raw LocaleDefinitions (to avoid issues with locale data existence checks)